<html>
<head>
<title>HTML_Progress::setModel</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">HTML_Progress</td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
  		  [ <a href="../classtrees_HTML_Progress.html" class="menu">class tree: HTML_Progress</a> ]
		  [ <a href="../elementindex_HTML_Progress.html" class="menu">index: HTML_Progress</a> ]
		  [ <a href="../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr>
<td width="10%" align="left" valign="bottom"><a href=
"../HTML_Progress/tutorial_progress.setui.pkg.html">Prev</a></td>
<td width="80%" align="center" valign="bottom"></td>
<td width="10%" align="right" valign="bottom"><a href=
"../HTML_Progress/tutorial_progress.isindeterminate.pkg.html">Next</a></td>
</tr>
</table>
<div><a name=""></a><div class="ref-title-box"><div class="ref-title"><span class="function">HTML_Progress::setModel</span></div>
  <div class="ref-purpose">sets the look-and-feel that renders the progress meter</div></div>

 <span><a name="synopsis"></a><h2 class="title">Synopsis</h2><div class="ref-synopsis"><p><p class="func-synopsis">require_once 'HTML/Progress.php';</p>
    void <span class="function">HTML_Progress::setModel</span>(
     string <i>$file</i>
     string <i>$type</i>)</p></div></span>

 <span><a name="description"></a><h2 class="title">Description</h2><p>This method is used as an easy way to customize
   with only one line of code and a configuration file, the look and feel of a progress meter.</p></span>

 <span><a name="parameter"></a><h2 class="title">Parameter</h2><p><ul class="parameter"><dl><dt>string
      <i>$file</i><dd>
     <li><p>file name of the configuration file that include model properties.</p></li></dl></ul>
    <ul class="parameter"><dl><dt>string
      <i>$type</i><dd>
     <li><p>type of external ressource (phpArray, iniFile, XML ...).</p></li></dl></ul></p></span>

 <span><a name="throws"></a><h2 class="title">Throws</h2><p><table frame = "border"><p><strong>Possible PEAR_Error values</strong></p><colgroup span = "4"/><thead><tr><td>Error level</td>
       <td>Error code</td>
       <td>Error message</td>
       <td>Solution</td></tr></thead>
     <tbody><tr><td>error</td>
       <td><b>HTML_PROGRESS_ERROR_INVALID_INPUT</b></td>
       <td>invalid input, parameter #1 &quot;<i>$file</i>&quot; was expecting &quot;file exists&quot;</td>
       <td>Fixed filename and path if misspell</td></tr>
      <tr><td>error</td>
       <td><b>HTML_PROGRESS_ERROR_INVALID_INPUT</b></td>
       <td>invalid input, parameter #1 &quot;<i>$ui</i>&quot; was expecting &quot;(a valid Config Container)&quot;</td>
       <td>Read the manual of PEAR::Config package</td></tr></tbody></table></p></span>

 <span><a name="note"></a><h2 class="title">Note</h2>( HTML_Progress &gt;= 1.0, Config &gt;= 0.9 )<br />
  <p><table class="note"><tr><td class="note_img"><img src="../media/important.png"></td><td class="note_text">This function can not be called statically.</td></tr></table></p>
  <p><table class="note"><tr><td class="note_img"><img src="../media/tip.png"></td><td class="note_text">You can use the same PHP code with different configuration files to present as much skins
    as you want.</td></tr></table></p></span>

 <span><a name="see"></a><h2 class="title">See</h2><p><a href="../HTML_Progress/tutorial_progress.setanimspeed.pkg.html">HTML_Progress::setAnimSpeed</a>,
   <a href="../HTML_Progress/tutorial_progress.setindeterminate.pkg.html">HTML_Progress::setIndeterminate</a>,
   <a href="../HTML_Progress/tutorial_dm.setincrement.pkg.html">HTML_Progress::setIncrement</a>,
   <a href="../HTML_Progress/tutorial_ui.setscript.pkg.html">HTML_Progress_UI::setScript</a>,
   <a href="../HTML_Progress/tutorial_ui.setorientation.pkg.html">HTML_Progress_UI::setOrientation</a>,
   <a href="../HTML_Progress/tutorial_ui.setfillway.pkg.html">HTML_Progress_UI::setFillWay</a>,
   <a href="../HTML_Progress/tutorial_ui.setcellcount.pkg.html">HTML_Progress_UI::setCellCount</a>,
   <a href="../HTML_Progress/tutorial_ui.setcellattributes.pkg.html">HTML_Progress_UI::setCellAttributes</a>,
   <a href="../HTML_Progress/tutorial_progress.setborderpainted.pkg.html">HTML_Progress::setBorderPainted</a>,
   <a href="../HTML_Progress/tutorial_ui.setborderattributes.pkg.html">HTML_Progress_UI::setBorderAttributes</a>,
   <a href="../HTML_Progress/tutorial_progress.setstringpainted.pkg.html">HTML_Progress::setStringPainted</a>,
   <a href="../HTML_Progress/tutorial_ui.setstringattributes.pkg.html">HTML_Progress_UI::setStringAttributes</a>,
   <a href="../HTML_Progress/tutorial_ui.setprogressattributes.pkg.html">HTML_Progress_UI::setProgressAttributes</a></p></span>

 <span><a name="example"></a><h2 class="title">Example</h2><p>Example below (that requires HTML_Progress &gt;= 1.2.0RC3) will produced the most older
    progress bar style.<br />
   <p><table class="note"><tr><td><img src="../media/example.png"></td><td><img src = "../media/screenshots/ancestor.png"/></td></tr></table></p>
   <p><div class="listing"><pre><ol><li><span class="src-php">&lt;?php </span></li>
<li><span class="src-inc">require_once </span><span class="src-str">'HTML/Progress.php'</span><span class="src-sym">;</span></li>
<li>&nbsp;</li>
<li><span class="src-var">$bar </span>= <span class="src-key">new </span><span class="src-id"><a href="../HTML_Progress/HTML_Progress.html">HTML_Progress</a></span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><span class="src-var">$bar</span><span class="src-sym">-&gt;</span><span class="src-id">setModel</span><span class="src-sym">(</span><span class="src-str">'./ancestor.ini'</span><span class="src-sym">, </span><span class="src-str">'iniCommented'</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><span class="src-var">$bar</span><span class="src-sym">-&gt;</span><span class="src-id">setAnimSpeed</span><span class="src-sym">(</span><span class="src-num">50</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-comm">// override the delay execution model</span></li>
<li><span class="src-php">?&gt;</span></li>
<li>&lt;html&gt;</li>
<li>&lt;head&gt;</li>
<li>&lt;title&gt;setModel example&lt;/title&gt;</li>
<li>&lt;style type=&quot;text/css&quot;&gt;</li>
<li>&lt;!--</li>
<li><span class="src-php">&lt;?php </span>echo <span class="src-var">$bar</span><span class="src-sym">-&gt;</span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetStyle">getStyle</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-php">?&gt;</span></li>
<li>// --&gt;</li>
<li>&lt;/style&gt;</li>
<li>&lt;script type=&quot;text/javascript&quot;&gt;</li>
<li>&lt;!--</li>
<li><span class="src-php">&lt;?php </span>echo <span class="src-var">$bar</span><span class="src-sym">-&gt;</span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetScript">getScript</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-php">?&gt;</span></li>
<li>//--&gt;</li>
<li>&lt;/script&gt;</li>
<li>&lt;/head&gt;</li>
<li>&lt;body&gt;</li>
<li>&nbsp;</li>
<li><span class="src-php">&lt;?php </span></li>
<li>echo <span class="src-var">$bar</span><span class="src-sym">-&gt;</span><span class="src-id">toHtml</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span></li>
<li><span class="src-var">$bar</span><span class="src-sym">-&gt;</span><span class="src-id">run</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><span class="src-php">?&gt;</span></li>
<li>&nbsp;</li>
<li>&lt;/body&gt;</li>
<li>&lt;/html&gt;</li>
</ol></pre></div></p></p></span></div>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr>
<td width="33%" align="left" valign="top"><a href="../HTML_Progress/tutorial_progress.setui.pkg.html">Prev</a></td>
<td width="34%" align="center" valign="top"><a href=
"../HTML_Progress/tutorial_part3-reference.pkg.html">Up</a></td>
<td width="33%" align="right" valign="top"><a href=
"../HTML_Progress/tutorial_progress.isindeterminate.pkg.html">Next</a></td>
</tr>

<tr>
<td width="33%" align="left" valign="top"><span class="function">HTML_Progress::setUI</span></td>
<td width="34%" align="center" valign="top">Reference Guide</td>
<td width="33%" align="right" valign="top"><span class="function">HTML_Progress::isIndeterminate</span></td>
</tr>
</table>
        <div class="credit">
		    <hr />
		    Documentation generated on Sun, 12 Sep 2004 20:23:11 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>